home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2005 October / PCWOCT05.iso / Software / FromTheMag / XAMPP 1.4.14 / xampp-win32-1.4.14-installer.exe / xampp / php / pear / docs / PhpDocumentor / Release-1.2.1 < prev    next >
Text File  |  2004-03-24  |  16KB  |  357 lines
  1. $Id: Release-1.2.1,v 1.1.2.18 2003/07/04 06:08:54 CelloG Exp $
  2.  
  3. PhpDocumentor Version 1.2.0 RELEASE CANDIDATE 2
  4. ################################################################################
  5. http://www.phpdoc.org
  6. Joshua Eichorn jeichorn@phpdoc.org
  7. Gregory Beaver cellog@users.sourceforge.net
  8. ################################################################################
  9. ################################################################################
  10.  
  11. The phpDocumentor team would like to announce the release of phpDocumentor
  12. 1.2.1.  This is a bugfix maintenance release.
  13.  
  14. Note that the license of phpDocumentor 1.2.1 is different from phpDocumentor 1.1.0.
  15. phpDocumentor 1.2.1 is under the PHP License version 3.0, full text is in
  16. PHPLICENSE.txt
  17.  
  18. for PEAR programmers, the new --pear command-line switch will be a boon.  Leave
  19. it on by default if your package follows PEAR coding and directory naming standards
  20.  
  21. ------
  22. IMPORTANT: phpDocumentor 1.2.1 requires PHP version 4.1.0 or greater.
  23. phpDocumentor will function best with PHP version 4.3.0 or greater, as it will
  24. use of the tokenizer extension if php 4.3.0 is installed for a tremendous
  25. increase in parsing speed.
  26. ------
  27.  
  28. phpDocumentor is a JavaDoc-like automatic documentation generator for PHP
  29. written in PHP.  It is the most versatile tool for documenting PHP.
  30.  
  31. Once again, phpDocumentor brings a great increase in usability with the 1.2
  32. branch.  The addition of a tokenizer-based parser increases parsing speed by
  33. up to 4 times (that's 400% faster) compared to previous versions.  In addition,
  34. scalability has been improved, allowing generation of documents in multiple
  35. output formats with one command.  The usage of config files makes repetitive
  36. parsing tasks straightforward and reduces the chance for error.
  37.  
  38. The addition of DocBlock templates, extended documentation (tutorials) parsing,
  39. and many other new features make this release the most useful automatic
  40. documentor for any programming language.
  41.  
  42. The default HTML Converter has been ported to a new Smarty-based converter,
  43. HTMLframesConverter, and all of the old templates have been ported to the new
  44. Smarty-based format.  The HTMLdefaultConverter has been deprecated since its
  45. functionality is redundant.  Due to the time it takes to convert a template to
  46. the new format, the phpDocumentor team extends an offer to do this conversion
  47. for anyone who has a brand new template.  We may also include the template in a
  48. future release, if permission is granted.
  49.  
  50. Due to interest from PEAR programmers, there is a new beta-quality XML:DocBook
  51. converter with peardoc2 templates.  This converter could also generate other
  52. DocBook formats, if desired, but does not generate indexing for this release.
  53.  
  54. The PDF Converter has stepped up to beta-quality, is fully templatable, and
  55. has most bugs completely fixed.  The CHM converter has also taken major strides
  56. and is beta quality.
  57.  
  58. As predicted, the Smarty template engine is the primary template engine for
  59. all converters.
  60.  
  61. For users new to phpDocumentor, phpDocumentor uses an event-driven parser
  62. and intermediary data structures that allow it to perform at a level other
  63. automatic documentors for PHP cannot achieve:
  64.   --parsing any php file, with multiple classes and functions in the same file
  65.   --fully compliant with even the most esoteric php syntax 
  66.       ($string = <<< EOF, for example)
  67.   --ability to generate multiple output formats
  68.   --extremely fast parsing
  69.   --error/warnings by line number and file to allow for debugging of
  70.     documentation tags
  71.   --multiple output templates to easily customize the look of generated
  72.     documentation
  73.   --extensive documentation of the package, including a detailed specification
  74.     for tags and the included template engine
  75.   --open source, GPL
  76.   
  77.  
  78. A full listing of all closed bugs and feature requests can be found in the 
  79. next section of the notes
  80.  
  81. phpDocumentor 1.2.1 ready for production use documenting any PHP project,
  82. download it and try the most advanced solution for PHP documentation
  83. today.
  84.  
  85. ################################################################################
  86.  
  87. The following bugs are fixed in version 1.2.1
  88.  [ 731750 ] Links to unparsed includes shown (reopened)
  89.  [ 735134 ] HTML:Smarty:default Documentation can not be printed
  90.  [ 749446 ] php-cli.exe has been renamed in the PHP 4.3.x distribution
  91.  [ 749841 ] The links do not work in errors.html. Page has no achors.
  92.  [ 750264 ] @ignore won't work with DocBlock Templates /**#@+
  93.  [ 750392 ] Formatting doesn't work in Templates /**#@+
  94.  [ 751066 ] Return type of a constructor is not void.
  95.  [ 751101 ] output error when optional parameters are in use
  96.  [ 752015 ] Docbuilder problems
  97.  [ 752040 ] phpDocumentor 1.2.0 can't parse itself in php < 4.3.0
  98.  [ 753278 ] @see parent::_privatefunc causes endless loop
  99.  [ 753641 ] phpdoc -h output
  100.  [ 755681 ] include error in docbuilder file_dialog.php
  101.  [ 755688 ] lost image(s)
  102.  [ 756730 ] preview image for HTML:Smarty not found
  103.  [ 757841 ] JavaScript-Error cause of Package-Name
  104.  [ 758387 ] Use of undefined constants in DocBlockTags.inc on line 830
  105.  [ 764412 ] Complex class inheritance/package causes endless loop
  106.  [ 765753 ] Extraneous trailing "-" in @uses when no description
  107.  [ 765765 ] docbuilder can't change ini dir
  108.  
  109. The following bugs are fixed in version 1.2.0
  110.  [ 729841 ] Source code only for certain file if same name used
  111.  [ 730081 ] --ignore-tags docs unclear
  112.  [ 730214 ] weird filesource
  113.  [ 731560 ] docbuilder include error on linux
  114.  [ 731750 ] Links to unparsed includes shown
  115.  [ 732900 ] ordered list messes up
  116.  [ 733100 ] phpdoc's help output shows 2 times option "quiet"
  117.  [ 733352 ] optional description parameter in @license tag
  118.  [ 732642 ] DocBook support broken/incomplete.
  119.  [ 735697 ] the web interface
  120.  [ 736832 ] Fatal error in phpDocumentorTParser.inc
  121.  [ 739740 ] Page-level docs are not generated without a @package tag
  122.  [ 740859 ] @uses in docblock template crashes parser
  123.  [ 740871 ] crash in DocBlockTags.inc line 99
  124.  [ 741887 ] case-sensitivity bug
  125.  [ 744026 ] @uses breaks on Classes.inc
  126.  [ 744028 ] {@link $el, $notfound} returns blank text
  127.  [ 746674 ] phpedit - vars, methods
  128.  [ 746690 ] DocBlocks not parsed for require_once statements
  129.  [ 746692 ] makedoc.sh $TITLE bug
  130.  [ 747733 ] cannot use same filename + different path in @example
  131.  [ 748314 ] --pear on php4/pear uses . as dirname
  132.  [ 748837 ] @uses with spaces
  133.  [ 748850 ] {@link} documentation is unclear
  134.  
  135. The following bugs are fixed in version 1.2.0RC2
  136.  [ 708928 ] write permissions needed on some program dirs
  137.  [ 723230 ] warning on line 1391, HighlightParser
  138.  [ 723320 ] @param output behaves funny
  139.  [ 723767 ] space needed after @param type $var
  140.  [ 723947 ] RIC parsing not reading the correct README
  141.  [ 724415 ] Non-package references not always resolved
  142.  [ 724417 ] Multi-level method references not linked
  143.  [ 724701 ] conflicting package names, inherited links fails to show up
  144.  [ 724857 ] @link URL text broken
  145.  [ 725247 ] Wrong list handling in peardoc converter
  146.  [ 725745 ] HTML:Smarty:* not creating ric_README.html
  147.  [ 725161 ] File view displays class symbols without names
  148.  [ 725788 ] if --packageoutput excludes files with classes
  149.  [ 725742 ] code tag alignment
  150.  [ 726195 ] Formatting tags breaks lists
  151.  [ 726313 ] Changelog not linked
  152.  [ 727823 ] "#@+"-block quirck?
  153.  [ 728585 ] static keyword
  154.  [ 728167 ] HTML tags are case sensitive
  155.  
  156. The following bugs are fixed in version 1.2.0RC1
  157.  [ 566663 ] @param &$arg broken
  158.  [ 657041 ] {@source} doesn't work right
  159.  [ 675871 ] --pear breaks if not a pear repository
  160.  [ 678176 ] Inherited vars/methods in HTML:frames:phpedit
  161.  [ 680652 ] Optional method/function parameters
  162.  [ 681459 ] {@internal}} not quite working
  163.  [ 681463 ] {@source} drops characters
  164.  [ 681735 ] {@source} in sdesc needs warning
  165.  [ 682490 ] {@internal}} not parsed right by highlightparser
  166.  [ 682491 ] multi-line description fubared in @tag
  167.  [ 687091 ] special characters not encoded
  168.  [ 687364 ] highlightparser $class->member incorrect
  169.  [ 687403 ] {@source} leaves "}"
  170.  [ 689874 ] is_a is not avaliable in PHP 4.1.0
  171.  [ 689893 ] Warnings on PHP 4.1.0
  172.  [ 689894 ] getincludevalue() missing argument 2 warning
  173.  [ 692522 ] @uses is screwy
  174.  [ 693213 ] tutorials post-processed twice
  175.  [ 693215 ] {@internal}} on single line not working
  176.  [ 694448 ] PKZip has bug, use winzip (not phpDocumentor bug)
  177.  [ 694594 ] PEAR mode: destructor image not shown by phpedit template
  178.  [ 694742 ] PDF converter has no table of contents
  179.  [ 695291 ] link to todo disappears in HTML:Smarty:*
  180.  [ 695482 ] @uses not checking for @access private
  181.  [ 695622 ] HTML:Smarty:* has no package-level docs
  182.  [ 696883 ] <code> in description crashes parser
  183.  [ 697156 ] PHP Warning with PDF Converter
  184.  [ 697656 ] putting a <code> inside a <li> turns it into a literal
  185.  [ 698417 ] {@link element descrip} wrong
  186.  [ 697644 ] parse fails if unmatched html tag, or text outside <li> list
  187.  [ 698468 ] Fatal error when inline tag across two lines
  188.  [ 698356 ] {@internal} not working properly
  189.  [ 701199 ] extra br in @filesource generation
  190.  [ 702549 ] --quiet option not valid?
  191.  [ 705897 ] HTML:frames:earthli misses Page.gif
  192.  [ 708560 ] intelligent list handling isn't quite working
  193.  [ 708559 ] @category tag not really working
  194.  [ 710366 ] <i>-Tag is ignored
  195.  [ 710700 ] empty defaultpackagename = caused busy loop
  196.  [ 711569 ] Fatal Error: Undefined Method during write
  197.  [ 712704 ] HTML:Smarty:* drops class level author information
  198.  [ 708914 ] <var>, <samp>, <kbd> broken
  199.  [ 713201 ] variable variables are not parsed properly in @global
  200.  [ 713954 ] @param type $var when &$var broken
  201.  [ 715077 ] HighlightParser needs @tag object classname support
  202.  [ 715084 ] HighlightParser craps out after $var->
  203.  [ 715452 ] @example doesn't work with anything other than .php
  204.  [ 718253 ] Using 'parent' in @example file causes crash
  205.  
  206. The following bugs are fixed in version 1.2.0BETA3
  207.  [ 661317 ] PDF converter in subpackage ids broken
  208.  [ 669945 ] CHM: "undefined function: convert()" with multiple outputs 
  209.  [ 670205 ] inherited methods have no links
  210.  [ 670341 ] <pre> in docblock doesn't htmlentitie
  211.  [ 670350 ] left_frame.tpl missing package level doc link
  212.  [ 670440 ] Io::getBase() is buggy
  213.  [ 670903 ] inline desc <code> not <pre>-ized
  214.  [ 671620 ] warning in Parser line 2271
  215.  [ 672149 ] @desc broken
  216.  [ 674053 ] Support for require_once 
  217.  [ 674059 ] requires PHP version 4.2 or higher
  218.  [ 674075 ] Bad @param kills parser
  219.  [ 677105 ] unbalanced HTML-comments in output of HTML:frames:phpedit
  220.  [ 677821 ] define not parsed right in highlightparser
  221.  [ 677822 ] {@source} not showing whole source
  222.  [ 677826 ] nonsense @link in @see breaks HTML output
  223.  [ 677938 ] whitespace wrong after certain docblocks
  224.  
  225. The following bugs are fixed in version 1.2.0BETA2
  226.  [ 665707 ] Warnings and errors in new_phpdoc.php
  227.  [ 666307 ] whitespace not ignored in @param
  228.  [ 669132 ] "no @package tag was used" error but @ignore & @package used
  229.  [ 669525 ] {$children[kids].sdesc} contains parent sdesc
  230.  [ 669613 ] Call to undefined function: getclassleft()
  231.  [ 669615 ] methods disapper
  232.  [ 669640 ] javadocdesc broken
  233.  [ 669909 ] PDF text starts off left side of page when have package.html
  234.  
  235. The following bugs are fixed in version 1.2.0BETA1a
  236.  [ 661976 ] @see broken
  237.  [ 662630 ] {} delimited variables within strings mess up the parser
  238.  [ 663435 ] define values, global variable values need htmlentities
  239.  [ 664058 ] @param not displayed in HTMLframesConverter 
  240.  
  241. The following bugs are fixed in version 1.2.0BETA1
  242.  
  243.  [ 586357 ] ignore a directory
  244.  [ 637921 ] sorting is weird with multiple package
  245.  [ 637928 ] multiple converters legal, but fails
  246.  [ 638042 ] two declarations of checkstate()
  247.  [ 638128 ] commandline win32 fails, w/relative path
  248.  [ 639553 ] new_phpdoc.php fails with php 4.2.3
  249.  [ 640507 ] constructor links broken
  250.  [ 641076 ] second instance of loop fails
  251.  [ 641235 ] need trim of -f and -d commandline
  252.  [ 641334 ] parse <script language="php"> as <?php
  253.  [ 642427 ] Incorrect Anchor link from elementIndex
  254.  [ 645588 ] elements named "function.." or "global.." don't link
  255.  [ 646281 ] {@link mailto:e@a descrip} broken
  256.  [ 647494 ] {@link element1, element2} incorrect
  257.  [ 648684 ] links to global vars, defines in Smarty wrong
  258.  [ 649646 ] comments not parsed in function
  259.  [ 649953 ] phpdoc command-line only runs from install dir
  260.  [ 650946 ] link to phpdoc.org new window
  261.  [ 651837 ] getLink broken in rare case
  262.  [ 653627 ] @staticvar broken
  263.  [ 654429 ] tutorial prev/next links not working
  264.  [ 655372 ] smarty template not found in pdf convers
  265.  [ 657041 ] {@source} doesn't work right
  266.  [ 657387 ] parent/child tutorials converted twice
  267.  [ 657726 ] used by link htmlentitiezed
  268.  [ 657739 ] need separate categories of {@tags}
  269.  [ 657934 ] subtrees not processed in Converter
  270.  [ 658120 ] PDF define template has bug
  271.  [ 658121 ] PDF Converter not passing elements sorte
  272.  [ 661316 ] @tutorial tutorial.ext#subsection.section broken
  273.  
  274. There of course were other small bugs fixed, these were just the bugs with 
  275. entries in source forge.  You can view the bug details or reopen it if
  276. you think it's not totally fixed at:
  277. http://sourceforge.net/tracker/?group_id=11194&atid=111194
  278.  
  279. Features added that had Feature Request entries in SF for 1.2.0:
  280.  [ 748419 ] Provide different tag variable types for template use
  281.  
  282. Features added that had Feature Request entries in SF for 1.2.0 rc 2:
  283.  [ 704808 ] command-line switch for template directory/converter directory
  284.  [ 722987 ] Relative example files
  285.  
  286. Features added that had Feature Request entries in SF for 1.2.0 rc 1:
  287.  [ 681470 ] Add syntax highlighting for <programlisting role="php"> 
  288.  [ 682810 ] Xref
  289.  [ 683101 ] starting/ending line numbers of docblocks/classes/methods
  290.  [ 687366 ] phpEdit-style list support
  291.  [ 695621 ] link to section of @filesource from each element
  292.  [ 714025 ] @license tag
  293.  
  294. Features added that had Feature Request entries in SF for 1.2.0 beta 3:
  295.  [ 674470 ] output a list of all @todos
  296.  [ 675194 ] -cp for converter-specific dynamic params 
  297.  
  298. Features added that had Feature Request entries in SF for 1.2.0 beta 2:
  299.  [ 650251 ] @filesource tag 
  300.  [ 670184 ] @example tag 
  301.  [ 670189 ] @internal/{@internal}} 
  302.  [ 670190 ] --ignore-tags command-line 
  303.  
  304. Features added that had Feature Request entries in SF for 1.2.0 beta 1a:
  305.  [ 663436 ] --title available in all pages, html
  306.  [ 663437 ] error if @package is missing 
  307.  [ 663439 ] PEAR command-line switch 
  308.  
  309. Features added that had Feature Request entries in SF for 1.2.0 beta 1:
  310.  
  311.  [ 541896 ] Create an Extended Howto
  312.  [ 558118 ] add {@inheritDoc}
  313.  [ 562604 ] Using @access blocs (_start ... _end)
  314.  [ 564991 ] auto-links to php manual
  315.  [ 566942 ] add {@link seeelement descrip}
  316.  [ 569746 ] make Program_root/ template thing
  317.  [ 577714 ] have master directory option
  318.  [ 586401 ] @access protected
  319.  [ 608603 ] REQUEST:class/function usage information
  320.  [ 615419 ] manuals like "php.net manual"
  321.  [ 623055 ] Zend IDE suport
  322.  [ 634518 ] inherit @author, @version, @copyright
  323.  [ 634589 ] @uses element
  324.  [ 634641 ] A way to document form variables
  325.  [ 635184 ] update all templates to phphtmllib
  326.  [ 637409 ] {keyword} - {data} pairs not flexible
  327.  [ 637660 ] parse type|type
  328.  [ 637920 ] simple way to extend a converter
  329.  [ 642235 ] Index of phphtmllib template
  330.  [ 645775 ] line numbers for elements
  331.  [ 651275 ] tutorials
  332.  [ 651716 ] automatically find README/INSTALL
  333.  [ 651723 ] @tutorial/{@tutorial}
  334.  [ 653608 ] allow the /user ini dir to be configable 
  335.  
  336. ################################################################################
  337.  
  338. The documentation has been updated for this release you can view it at
  339. http://phpdocu.sourceforge.net/spec/
  340. or in the distribution in the spec directory
  341.  
  342. The changelog is available in the tarball, or online at 
  343. http://phpdocu.sourceforge.net/Changelog
  344.  
  345. You can download the newest version from 
  346. http://phpdocu.sourceforge.net/downloads.php
  347.  
  348. And of course you can reach the webpage at http://phpdocu.sourceforge.net/ or 
  349. http://phpdoc.org/ 
  350.  
  351. enjoy
  352. -joshua eichorn <jeichorn@phpdoc.org>
  353. -gregory beaver <cellog@users.sourceforge.net>
  354.  
  355.  
  356. vim: set expandtab :
  357.